home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / snrm2.z / snrm2
Encoding:
Text File  |  2002-10-03  |  13.0 KB  |  265 lines

  1.  
  2.  
  3.  
  4. SSSSNNNNRRRRMMMM2222((((3333SSSS))))                                                            SSSSNNNNRRRRMMMM2222((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSSSNNNNRRRRMMMM2222, DDDDNNNNRRRRMMMM2222, SSSSCCCCNNNNRRRRMMMM2222, DDDDZZZZNNNNRRRRMMMM2222 - Computes the Euclidean norm of a vector
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      Single precision
  13.  
  14.           Fortran:
  15.                rrrreeeeaaaallll SSSSNNNNRRRRMMMM2222
  16.                rrrreeeeaaaallll _e_n_r_m
  17.                _e_n_r_m ==== SSSSNNNNRRRRMMMM2222 ((((_n,,,, _x,,,, _i_n_c_x))))
  18.  
  19.           C/C++:
  20.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  21.                ffffllllooooaaaatttt ssssnnnnrrrrmmmm2222 ((((iiiinnnntttt _n,,,, ffffllllooooaaaatttt *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  22.  
  23.      Double precision
  24.  
  25.           Fortran:
  26.                ddddoooouuuubbbblllleeee pppprrrreeeecccciiiissssiiiioooonnnn DDDDNNNNRRRRMMMM2222
  27.                ddddoooouuuubbbblllleeee pppprrrreeeecccciiiissssiiiioooonnnn _e_n_r_m
  28.                _e_n_r_m ==== DDDDNNNNRRRRMMMM2222 ((((_n,,,, _x_i,,,, _i_n_c_x))))
  29.  
  30.           C/C++:
  31.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  32.                ddddoooouuuubbbblllleeee ddddnnnnrrrrmmmm2222 ((((iiiinnnntttt _n,,,, ddddoooouuuubbbblllleeee *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  33.  
  34.      Single precision complex
  35.  
  36.           Fortran:
  37.                rrrreeeeaaaallll SSSSCCCCNNNNRRRRMMMM2222
  38.                rrrreeeeaaaallll _e_n_r_m
  39.                _e_n_r_m ==== SSSSCCCCNNNNRRRRMMMM2222 ((((_n,,,, _x,,,, _i_n_c_x))))
  40.  
  41.           C/C++:
  42.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  43.                ffffllllooooaaaatttt ssssccccnnnnrrrrmmmm2222 ((((iiiinnnntttt _n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  44.  
  45.           C++ STL:
  46.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  47.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  48.                ffffllllooooaaaatttt ssssccccnnnnrrrrmmmm2222 ((((iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  49.  
  50.      Double precision complex
  51.  
  52.           Fortran:
  53.                ddddoooouuuubbbblllleeee pppprrrreeeecccciiiissssiiiioooonnnn DDDDZZZZNNNNRRRRMMMM2222
  54.                ddddoooouuuubbbblllleeee pppprrrreeeecccciiiissssiiiioooonnnn _e_n_r_m
  55.                _e_n_r_m ==== DDDDZZZZNNNNRRRRMMMM2222 ((((_n,,,, _x_i,,,, _i_n_c_x))))
  56.  
  57.           C/C++:
  58.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  59.                ddddoooouuuubbbblllleeee ddddzzzznnnnrrrrmmmm2222 ((((iiiinnnntttt _n,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSNNNNRRRRMMMM2222((((3333SSSS))))                                                            SSSSNNNNRRRRMMMM2222((((3333SSSS))))
  71.  
  72.  
  73.  
  74.           C++ STL:
  75.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  76.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  77.                ddddoooouuuubbbblllleeee ddddzzzznnnnrrrrmmmm2222 ((((iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  78.  
  79. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  80.      These routines are part of the SCSL Scientific Library and can be loaded
  81.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  82.      directs the linker to use the multi-processor version of the library.
  83.  
  84.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  85.      4 bytes (32 bits). Another version of SCSL is available in which integers
  86.      are 8 bytes (64 bits).  This version allows the user access to larger
  87.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  88.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  89.      only one of the two versions; 4-byte integer and 8-byte integer library
  90.      calls cannot be mixed.
  91.  
  92.      The C and C++ prototypes shown above are appropriate for the 4-byte
  93.      integer version of SCSL. When using the 8-byte integer version, the
  94.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  95.      file should be included.
  96.  
  97. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  98.      SSSSNNNNRRRRMMMM2222/DDDDNNNNRRRRMMMM2222 computes the Euclidean (_l_2) norm of a real vector, as
  99.      follows:
  100.  
  101.           enrm <- ||x||   =
  102.                        2
  103.  
  104.                  T            n      2
  105.           sqrt (x x) = sqrt (Sum * x  )
  106.                              i=1    i
  107.  
  108.  
  109.  
  110.      where _x is a real vector, and _x_T denotes the transpose of _x.
  111.  
  112.      SSSSCCCCNNNNRRRRMMMM2222/DDDDZZZZNNNNRRRRMMMM2222 computes the Euclidean (_l_2) norm of a complex vector, as
  113.      follows:
  114.  
  115.           enrm <- ||x||  =
  116.                        2
  117.                  H            n  _
  118.           sqrt (x x) = sqrt (Sum x x )
  119.                              i=1  i i
  120.  
  121.  
  122.      where _x is a complex vector, and _x_H denotes the conjugate transpose of _x.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSNNNNRRRRMMMM2222((((3333SSSS))))                                                            SSSSNNNNRRRRMMMM2222((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      See the NOTES section of this man page for information about the
  141.      interpretation of the data types described in the following arguments.
  142.  
  143.      These functions have the following arguments:
  144.  
  145.      _e_n_r_m      Result.  (output)
  146.                SSSSNNNNRRRRMMMM2222: Single precision result.
  147.                DDDDNNNNRRRRMMMM2222: Double precision result.
  148.                SSSSCCCCNNNNRRRRMMMM2222: Single precision complex result.
  149.                DDDDZZZZNNNNRRRRMMMM2222:  Double precision complex result.
  150.                Result (Euclidean norm).  If _n <= 0, _e_n_r_m is set to 0.
  151.  
  152.      _n         Integer.  (input)
  153.                Number of elements in the operand vector.
  154.  
  155.      _x         Array of dimension (_n-1) * |_i_n_c_x| + 1.  (input)
  156.                SSSSNNNNRRRRMMMM2222: Single precision array.
  157.                DDDDNNNNRRRRMMMM2222: Double precision array.
  158.                SSSSCCCCNNNNRRRRMMMM2222: Single precision complex array.
  159.                DDDDZZZZNNNNRRRRMMMM2222:  Double precision complex array.
  160.                Array _x contains the operand vector.
  161.  
  162.      _i_n_c_x      Integer.  (input)
  163.                Increment between elements of _x.  If _i_n_c_x = 0, the results will
  164.                be unpredictable.
  165.  
  166. NNNNOOOOTTTTEEEESSSS
  167.      These routines are Level 1 Basic Linear Algebra Subprograms (Level 1
  168.      BLAS).
  169.  
  170.      When working backward (_i_n_c_x < 0), each routine starts at the end of the
  171.      vector and moves backward, as follows:
  172.  
  173.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)), ..., _x(1)
  174.  
  175.  
  176.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  177.      The following data types are described in this documentation:
  178.  
  179.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  180.  
  181.      Fortran:
  182.  
  183.           Array dimensioned _n           xxxx((((nnnn))))
  184.  
  185.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  186.  
  187.           Single precision              RRRREEEEAAAALLLL
  188.  
  189.           Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSNNNNRRRRMMMM2222((((3333SSSS))))                                                            SSSSNNNNRRRRMMMM2222((((3333SSSS))))
  203.  
  204.  
  205.  
  206.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  207.  
  208.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  209.  
  210.      C/C++:
  211.  
  212.           Array dimensioned _n           xxxx[[[[_n]]]]
  213.  
  214.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  215.  
  216.           Single precision              ffffllllooooaaaatttt
  217.  
  218.           Double precision              ddddoooouuuubbbblllleeee
  219.  
  220.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  221.  
  222.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  223.  
  224.      C++ STL:
  225.  
  226.           Array dimensioned _n           xxxx[[[[_n]]]]
  227.  
  228.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  229.  
  230.           Single precision              ffffllllooooaaaatttt
  231.  
  232.           Double precision              ddddoooouuuubbbblllleeee
  233.  
  234.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  235.  
  236.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  237.  
  238. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  239.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS1111(3S)
  240.  
  241.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  242.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  243.      Linear Algebra Subprograms Technical Forum.
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.                                                                         PPPPaaaaggggeeee 4444
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.